org.springframework.web.reactive.config

Class CorsRegistration

java.lang.Object

org.springframework.web.reactive.config.CorsRegistration

public class CorsRegistration
extends java.lang.Object

Assists with the creation of a CorsConfiguration instance mapped to a path pattern. By default all origins, headers, and credentials for GET, HEAD, and POST requests are allowed while the max age is set to 30 minutes.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

See Also:

CorsRegistry

Field Summary

Fields

Modifier and Type	Field and Description
private CorsConfiguration	config
private java.lang.String	pathPattern

Constructor Summary

Constructors

Constructor and Description
CorsRegistration(java.lang.String pathPattern) Create a new CorsRegistration that allows all origins, headers, and credentials for GET, HEAD, and POST requests with max age set to 1800 seconds (30 minutes) for the specified path.

Method Summary

Modifier and Type	Method and Description
CorsRegistration	allowCredentials(boolean allowCredentials) Whether user credentials are supported.
CorsRegistration	allowedHeaders(java.lang.String... headers) Set the list of headers that a pre-flight request can list as allowed for use during an actual request.
CorsRegistration	allowedMethods(java.lang.String... methods) Set the HTTP methods to allow, e.g.
CorsRegistration	allowedOrigins(java.lang.String... origins) Set the origins to allow, e.g.
CorsRegistration	exposedHeaders(java.lang.String... headers) Set the list of response headers other than "simple" headers, i.e.
protected CorsConfiguration	getCorsConfiguration()
protected java.lang.String	getPathPattern()
CorsRegistration	maxAge(long maxAge) Configure how long in seconds the response from a pre-flight request can be cached by clients.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pathPattern

private final java.lang.String pathPattern

config

private final CorsConfiguration config

Constructor Detail

CorsRegistration

public CorsRegistration(java.lang.String pathPattern)

Create a new CorsRegistration that allows all origins, headers, and credentials for GET, HEAD, and POST requests with max age set to 1800 seconds (30 minutes) for the specified path.

Parameters:

pathPattern - the path that the CORS configuration should apply to; exact path mapping URIs (such as "/admin") are supported as well as Ant-style path patterns (such as "/admin/**").

Method Detail

allowedOrigins

public CorsRegistration allowedOrigins(java.lang.String... origins)

Set the origins to allow, e.g. "http://domain1.com".

The special value "*" allows all domains.

By default all origins are allowed.

allowedMethods

public CorsRegistration allowedMethods(java.lang.String... methods)

Set the HTTP methods to allow, e.g. "GET", "POST", etc.

The special value "*" allows all methods.

By default "simple" methods GET, HEAD, and POST are allowed.

allowedHeaders

public CorsRegistration allowedHeaders(java.lang.String... headers)

Set the list of headers that a pre-flight request can list as allowed for use during an actual request.

The special value "*" may be used to allow all headers.

A header name is not required to be listed if it is one of: Cache-Control, Content-Language, Expires, Last-Modified, or Pragma as per the CORS spec.

By default all headers are allowed.

exposedHeaders

public CorsRegistration exposedHeaders(java.lang.String... headers)

Set the list of response headers other than "simple" headers, i.e. Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, or Pragma, that an actual response might have and can be exposed.

Note that "*" is not supported on this property.

By default this is not set.

maxAge

public CorsRegistration maxAge(long maxAge)

Configure how long in seconds the response from a pre-flight request can be cached by clients.

By default this is set to 1800 seconds (30 minutes).

allowCredentials

public CorsRegistration allowCredentials(boolean allowCredentials)

Whether user credentials are supported.

By default this is set to true in which case user credentials are supported.

getPathPattern

protected java.lang.String getPathPattern()

getCorsConfiguration

protected CorsConfiguration getCorsConfiguration()